Motion.SetAxisParameter method

Sets the value of a vendor-specific parameter for an axis. The parameters are defined in McAxisParameter.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus SetAxisParameter(
       int Index,
       McAxisParameter ParameterNumber,
       double Value,
       McExecutionMode ExecutionMode
)

Public Function SetAxisParameter(
       Index As Integer,
       ParameterNumber As McAxisParameter,
       Value As Double,
       ExecutionMode As McExecutionMode
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

ParameterNumber [in]

Type: McAxisParameter

A parameter from McAxisParameter. You can use the parameter name or its corresponding number.

Value [in]

Type: double

Writes the value to the parameter you picked from McAxisParameter. For example, if you pick mcHomingMode from McAxisParameter, you need to select a mode from the McHomingMode enum and write its value here.

ExecutionMode [in]

Type: McExecutionMode

Defines the chronological sequence of a method.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

When modulo axis is enabled, the input value is converted to the modulo position for mcSoftLimitPositive, mcSoftwareLimitPositive, mcSoftLimitNegative, or mcSoftwareLimitNegative in McAxisParameter.

For example:

If the current axis position is 0 and the positive limit is 510, the value is converted to 150 (510 % 360)
If the current axis position is 0 and the negative limit is -300, the value is converted to 60 (-300 % 360)

As a result, the axis cannot move beyond 150 in the positive direction or 60 in the negative direction.

Examples

N/A